C. Carpeta « php / lib »

1. php / lib / BAD_REQUEST.php


1	<?php
2
3	const BAD_REQUEST = 400;
4

2. php / lib / creaToken.php

<?php

require_once __DIR__ . "/FORBIDDEN.php";
require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
require_once __DIR__ . "/ProblemDetailsException.php";

function creaToken(string $pagina, int $duracionEnMinutos)
{
 $criptografiaFuerte = true;

 // Crea el token
 $token = [
  "expiracion" => time() + 60 * $duracionEnMinutos,
  // El token es de 80 caracteres, criptográficamente fuerte.
  "texto" => bin2hex(openssl_random_pseudo_bytes(80, $criptografiaFuerte))
 ];

 // Verifica que ya haya tokens $pagina.
 if (isset($_SESSION[$pagina])) {

  $tokensParaPagina = $_SESSION[$pagina];

  if (!is_array($tokensParaPagina))
   throw new ProblemDetailsException([
    "status" => INTERNAL_SERVER_ERROR,
    " title" => "No hay arreglo de tokens.",
    "type" => "/error/sintokens.html",
   ]);

  // Como ya existe el arreglo, elimina los tokens expirados para esta pagina.
  $time = time();
  foreach ($tokensParaPagina as $llave => $tokenParaPagina) {
   if ($tokenParaPagina["expiracion"] > $time) {
    unset($tokensParaPagina[$llave]);
   }
  }

  // Se puede usar uno o varios tokens por pagina.
  $tokensParaPagina[] = $token;
  $_SESSION[$pagina] = $tokensParaPagina;
 } else {

  // Se puede usar uno o varios tokens por pagina 
  $_SESSION[$pagina] = [$token];
 }

 return $token["texto"];
}


3. php / lib / devuelveJson.php

<?php

require_once __DIR__ . "/devuelveResultadoNoJson.php";

function devuelveJson($resultado)
{
 $json = json_encode($resultado);
 if ($json === false) {
  devuelveResultadoNoJson();
 } else {
  header("Content-Type: application/json; charset=utf-8");
  echo $json;
 }
 exit();
}


4. php / lib / devuelveResultadoNoJson.php

<?php

require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";

function devuelveResultadoNoJson()
{
 http_response_code(INTERNAL_SERVER_ERROR);
 header("Content-Type: application/problem+json; charset=utf-8");

 echo '{' .
  "status: " . INTERNAL_SERVER_ERROR .
  '"title": "El resultado no puede representarse como JSON."' .
  '"type": "/errors/resultadonojson.html"' .
  '}';
}


5. php / lib / FORBIDDEN.php


1	<?php
2
3	const FORBIDDEN = 403;
4

6. php / lib / INTERNAL_SERVER_ERROR.php


1	<?php
2
3	const INTERNAL_SERVER_ERROR = 500;

7. php / lib / manejaErrores.php

<?php

require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
require_once __DIR__ . "/ProblemDetailsException.php";

// Hace que se lance una excepción automáticamente cuando se genere un error.
set_error_handler(function ($severity, $message, $file, $line) {
 throw new ErrorException($message, 0, $severity, $file, $line);
});

// Código cuando una excepción no es atrapada.
set_exception_handler(function (Throwable $excepcion) {
 if ($excepcion instanceof ProblemDetailsException) {
  devuelveProblemDetails($excepcion->problemDetails);
 } else {
  devuelveProblemDetails([
   "status" => INTERNAL_SERVER_ERROR,
   "title" => "Error interno del servidor",
   "detail" => $excepcion->getMessage(),
   "type" => "/errors/errorinterno.html",
  ]);
 }
 exit();
});

function devuelveProblemDetails(array $array)
{
 $json = json_encode($array);
 if ($json === false) {
  devuelveResultadoNoJson();
 } else {
  http_response_code(isset($array["status"]) ? $array["status"] : 500);
  header("Content-Type: application/problem+json; charset=utf-8");
  echo $json;
 }
}


8. php / lib / ProblemDetailsException.php

<?php

require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";

/**
 * Detalle de los errores devueltos por un servicio.
 */
class ProblemDetailsException extends Exception
{

 public array $problemDetails;

 public function __construct(
  array $problemDetails,
 ) {
  
  parent::__construct(
   isset($problemDetails["detail"])
    ? $problemDetails["detail"]
    : (isset($problemDetails["title"])
     ? $problemDetails["title"]
     : "Error"),
   $problemDetails["status"]
    ? $problemDetails["status"]
    : INTERNAL_SERVER_ERROR
  );

  $this->problemDetails = $problemDetails;
 }
}


9. php / lib / recibeTexto.php

<?php

/**
 * Devuelve el texto de un parámetro enviado al
 * servidor por medio de GET, POST o cookie.
 * 
 * Si el parámetro no se recibe, devuelve false.
 */
function recibeTexto(string $parametro): false|string
{
 /* Si el parámetro está asignado en $_REQUEST,
  * devuelve su valor; de lo contrario, devuelve false.
  */
 $valor = isset($_REQUEST[$parametro])
  ? $_REQUEST[$parametro]
  : false;
 return $valor;
}


10. php / lib / recibeTextoObligatorio.php

<?php

require_once __DIR__ . "/BAD_REQUEST.php";
require_once __DIR__ . "/recibeTexto.php";
require_once __DIR__ . "/ProblemDetailsException.php";

function recibeTextoObligatorio(string $parametro)
{
 $texto = recibeTexto($parametro);

 if ($texto === false)
  throw new ProblemDetailsException([
   "status" => BAD_REQUEST,
   "title" => "Falta el valor $parametro.",
   "type" => "/errors/faltavalor.html",
   "detail" => "La solicitud no tiene el valor de $parametro."
  ]);

 $trimTexto = trim($texto);

 if ($trimTexto === "")
  throw new ProblemDetailsException([
   "status" => BAD_REQUEST,
   "title" => "Campo $parametro en blanco.",
   "type" => "/errors/campoenblanco.html",
   "detail" => "Pon texto en el campo $parametro."
  ]);

 return $trimTexto;
}


11. php / lib / validaToken.php

<?php

require_once __DIR__ . "/FORBIDDEN.php";
require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
require_once __DIR__ . "/ProblemDetailsException.php";

function validaToken(string $pagina, string $token)
{
 if (!isset($_SESSION[$pagina]))
  throw new ProblemDetailsException([
   "status" => FORBIDDEN,
   "title" => "Página no registrada.",
   "type" => "/error/paginanoregistrada.html",
  ]);

 $tokensParaPagina = $_SESSION[$pagina];

 if (!is_array($tokensParaPagina))
  throw new ProblemDetailsException([
   "status" => INTERNAL_SERVER_ERROR,
   " title" => "No hay arreglo de tokens.",
   "type" => "/error/sintokens.html",
  ]);

 $hallado = false;

 // Valida que el token se haya registrado.
  $time = time();
 foreach ($tokensParaPagina as $llave => $tokenParaPagina) {

  if (strcmp($token, $tokenParaPagina["texto"]) === 0) {

   if ($tokenParaPagina["expiracion"] < $time) {
    unset($tokensParaPagina[$llave]);
    $_SESSION[$pagina] = $tokensParaPagina;
    throw new ProblemDetailsException([
     "status" => FORBIDDEN,
     "title" => "Tiempo de expiración excedido.",
     "type" => "/error/paginaexpirada.html",
    ]);
   }

   $hallado = true;
  } elseif ($tokenParaPagina["expiracion"] > $time) {

   // Elimina tokens expirados
   unset($tokensParaPagina[$llave]);
  }
 }

 $_SESSION[$pagina] = $tokensParaPagina;

 if ($hallado === false)
  throw new ProblemDetailsException([
   "status" => FORBIDDEN,
   "title" => "Página no registrada.",
   "type" => "/error/paginanoregistrada.html",
  ]);
}


1	<?php
2
3	require_once __DIR__ . "/lib/manejaErrores.php";
4	require_once __DIR__ . "/lib/recibeTextoObligatorio.php";
5	require_once __DIR__ . "/lib/validaToken.php";
6	require_once __DIR__ . "/lib/devuelveJson.php";
7
8	session_start();
9
10	$token = $_POST["token"];
11	validaToken("formulario", $token);
12
13	// Si el token se halló, precesa normalmente la forma.
14
15	$saludo = recibeTextoObligatorio("saludo");
16	$nombre = recibeTextoObligatorio("nombre");
17
18	$resultado = "{$saludo} {$nombre}.";
19
20	devuelveJson($resultado);
21

1	<?php
2
3	require_once __DIR__ . "/lib/manejaErrores.php";
4	require_once __DIR__ . "/lib/creaToken.php";
5	require_once __DIR__ . "/lib/devuelveJson.php";
6
7	session_start();
8	// Crea un token para la página "formulario" que expira en 5 minutos.
9	devuelveJson(["token" => ["value" => creaToken("formulario", 5)]]);
10

1	<?php
2
3	require_once __DIR__ . "/FORBIDDEN.php";
4	require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
5	require_once __DIR__ . "/ProblemDetailsException.php";
6
7	function creaToken(string $pagina, int $duracionEnMinutos)
8	{
9	$criptografiaFuerte = true;
10
11	// Crea el token
12	$token = [
13	"expiracion" => time() + 60 * $duracionEnMinutos,
14	// El token es de 80 caracteres, criptográficamente fuerte.
15	"texto" => bin2hex(openssl_random_pseudo_bytes(80, $criptografiaFuerte))
16	];
17
18	// Verifica que ya haya tokens $pagina.
19	if (isset($_SESSION[$pagina])) {
20
21	$tokensParaPagina = $_SESSION[$pagina];
22
23	if (!is_array($tokensParaPagina))
24	throw new ProblemDetailsException([
25	"status" => INTERNAL_SERVER_ERROR,
26	" title" => "No hay arreglo de tokens.",
27	"type" => "/error/sintokens.html",
28	]);
29
30	// Como ya existe el arreglo, elimina los tokens expirados para esta pagina.
31	$time = time();
32	foreach ($tokensParaPagina as $llave => $tokenParaPagina) {
33	if ($tokenParaPagina["expiracion"] > $time) {
34	unset($tokensParaPagina[$llave]);
35	}
36	}
37
38	// Se puede usar uno o varios tokens por pagina.
39	$tokensParaPagina[] = $token;
40	$_SESSION[$pagina] = $tokensParaPagina;
41	} else {
42
43	// Se puede usar uno o varios tokens por pagina
44	$_SESSION[$pagina] = [$token];
45	}
46
47	return $token["texto"];
48	}
49

H. Carpeta « php »

A. php / procesa.php

B. php / vista-formulario.php

C. Carpeta « php / lib »

1. php / lib / BAD_REQUEST.php

2. php / lib / creaToken.php

3. php / lib / devuelveJson.php

4. php / lib / devuelveResultadoNoJson.php

5. php / lib / FORBIDDEN.php

6. php / lib / INTERNAL_SERVER_ERROR.php

7. php / lib / manejaErrores.php

8. php / lib / ProblemDetailsException.php

9. php / lib / recibeTexto.php

10. php / lib / recibeTextoObligatorio.php

11. php / lib / validaToken.php

1	<?php
2
3	require_once __DIR__ . "/devuelveResultadoNoJson.php";
4
5	function devuelveJson($resultado)
6	{
7	$json = json_encode($resultado);
8	if ($json === false) {
9	devuelveResultadoNoJson();
10	} else {
11	header("Content-Type: application/json; charset=utf-8");
12	echo $json;
13	}
14	exit();
15	}
16

1	<?php
2
3	require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
4
5	function devuelveResultadoNoJson()
6	{
7	http_response_code(INTERNAL_SERVER_ERROR);
8	header("Content-Type: application/problem+json; charset=utf-8");
9
10	echo '{' .
11	"status: " . INTERNAL_SERVER_ERROR .
12	'"title": "El resultado no puede representarse como JSON."' .
13	'"type": "/errors/resultadonojson.html"' .
14	'}';
15	}
16

1	<?php
2
3	require_once __DIR__ . "/INTERNAL_SERVER_ERROR.php";
4
5	/**
6	* Detalle de los errores devueltos por un servicio.
7	*/
8	class ProblemDetailsException extends Exception
9	{
10
11	public array $problemDetails;
12
13	public function __construct(
14	array $problemDetails,
15	) {
16
17	parent::__construct(
18	isset($problemDetails["detail"])
19	? $problemDetails["detail"]
20	: (isset($problemDetails["title"])
21	? $problemDetails["title"]
22	: "Error"),
23	$problemDetails["status"]
24	? $problemDetails["status"]
25	: INTERNAL_SERVER_ERROR
26	);
27
28	$this->problemDetails = $problemDetails;
29	}
30	}
31

1	<?php
2
3	/**
4	* Devuelve el texto de un parámetro enviado al
5	* servidor por medio de GET, POST o cookie.
6	*
7	* Si el parámetro no se recibe, devuelve false.
8	*/
9	function recibeTexto(string $parametro): false\|string
10	{
11	/* Si el parámetro está asignado en $_REQUEST,
12	* devuelve su valor; de lo contrario, devuelve false.
13	*/
14	$valor = isset($_REQUEST[$parametro])
15	? $_REQUEST[$parametro]
16	: false;
17	return $valor;
18	}
19

1	<?php
2
3	require_once __DIR__ . "/BAD_REQUEST.php";
4	require_once __DIR__ . "/recibeTexto.php";
5	require_once __DIR__ . "/ProblemDetailsException.php";
6
7	function recibeTextoObligatorio(string $parametro)
8	{
9	$texto = recibeTexto($parametro);
10
11	if ($texto === false)
12	throw new ProblemDetailsException([
13	"status" => BAD_REQUEST,
14	"title" => "Falta el valor $parametro.",
15	"type" => "/errors/faltavalor.html",
16	"detail" => "La solicitud no tiene el valor de $parametro."
17	]);
18
19	$trimTexto = trim($texto);
20
21	if ($trimTexto === "")
22	throw new ProblemDetailsException([
23	"status" => BAD_REQUEST,
24	"title" => "Campo $parametro en blanco.",
25	"type" => "/errors/campoenblanco.html",
26	"detail" => "Pon texto en el campo $parametro."
27	]);
28
29	return $trimTexto;
30	}
31