Para quem não saber, url amigável é utilizado para deixar as url’s de um site mais “bonitas“. Exemplo: temos um produto TÊNIS, sem url amigável o seu sistema provavelmente iria ter como url algo como (http://www.seusite.com.br/index.php?product_id=123) que iria indicar o ID do produto para que você possa encontrar qual produto exibir na tela do usuário. Usando url amigável você transforma a url em algo que diz um pouco mais sobre o produto (http://www.seusite.com.br/produto/tenis) dessa forma conseguimos deixar uma url mais facil de decorar, entender e divulgar, sem contar que melhora a indexação do seu site em SEO(Search Engine Optimization), pois da mesma forma que fica mais fácil para um usuário entender do que se trata a url, também fica mais fácil para o Google ou qualquer outro sistema de busca categorizar as suas páginas.

Existem várias maneiras de fazer url amigável, a maneira que utilizo é guardando no banco de dados o nome que desejo para o produto como url. Então se o nome do produto é TÊNIS MARCA X PRETO no campo Url Amigável eu preencho tenis_marca_x_preto que será utilizado na url. No meu sistema eu deixo esse campo a ser preenchido pelo Cliente(olha o perigo rss) na própria adminstração do produto, porém como se é de imaginar, o cliente não tem visão de que esse é um campo importante e acaba deixando em branco ou pior, quando travo como um campo obrigatório e valido o campo para não permitir espaços, acentos e outros caracteres especiais o cliente simplesmente não consegue cadastrar o produto, pois não consegue gerar uma url válida.

Sendo assim resolvi criar uma FUNCTION em MySql que converta automaticamente o nome do produto, categoria, etc em uma url amigável válida. Também criei uma TRIGGER que valida se o usuário preencheu o campo, caso não tenha preenchido a trigger dispara a function convertendo o nome e gravando o campo url amigável.

Bom chega de histórinhas e vamos ao que interessa, como criar a tal função e o tal gatilho.

A FUCNTION funciona de uma maneira bem simples, basicamente troco os caracteres indesejádos por caracteres válidos para uma url e retorno o nome já convertido para ser usado.

CREATE FUNCTION urlAmigavel(name VARCHAR(255)) RETURNS VARCHAR(255)
BEGIN
	DECLARE campo VARCHAR(255);
	SET campo = TRIM(UCASE(name));
	SET campo = REPLACE(campo ,'Á','A');
	SET campo = REPLACE(campo ,'À','A');
	SET campo = REPLACE(campo ,'Ã','A');
	SET campo = REPLACE(campo ,'Â','A');
	SET campo = REPLACE(campo ,'É','E');
	SET campo = REPLACE(campo ,'È','E');
	SET campo = REPLACE(campo ,'Ê','E');
	SET campo = REPLACE(campo ,'Í','I');
	SET campo = REPLACE(campo ,'Ì','I');
	SET campo = REPLACE(campo ,'Î','I');
	SET campo = REPLACE(campo ,'Ó','O');
	SET campo = REPLACE(campo ,'Ò','O');
	SET campo = REPLACE(campo ,'Ô','O');
	SET campo = REPLACE(campo ,'Õ','O');
	SET campo = REPLACE(campo ,'Ú','U');
	SET campo = REPLACE(campo ,'Ù','U');
	SET campo = REPLACE(campo ,'Û','U');
	SET campo = REPLACE(campo ,'Ü','U');
	SET campo = REPLACE(campo ,'Ç','C');
	SET campo = REPLACE(campo ,'  ','_');
	SET campo = REPLACE(campo ,' ','_');
	SET campo = REPLACE(campo ,'+','');
	SET campo = REPLACE(campo ,'_-_','-');
	SET campo = REPLACE(campo ,'/','');
	SET campo = REPLACE(campo ,'\\','');
	SET campo = REPLACE(campo ,'?','');
	SET campo = REPLACE(campo ,'&','');
	SET campo = REPLACE(campo ,'__','_');
	RETURN LCASE(campo);
END;

OBS: Caso queria alterar a FUNCTION depois de já ter criado ela no seu banco de dados, é necessário apagar a função e criar novamente. O comando para apagar seria o (DROP FUNCTION `nomeDaFuncao`;)

Após criada a função podemos testar, executando a função na tabela de produtos e no campo nome, assim é possível visualizar como vai ficar os nomes antes de atualizar.

SELECT urlAmigavel(campoNomeProduto) FROM tabelaProduto

Veja que o retorno desta query é o nome do produto já retirando os espaços, acentos e caracteres especiais. Neste exemplo coloquei os caracteres que achei necessário, caso tenha necessidade de substituir mais algum outro caracter que não conste nessa lista, você pode adicionar seguindo como exemplo os outros caracteres que foram tratados na função.

No meu caso o data base do cliente já estáva com vários produtos cadastrados então tive que atualizar o campo url_amigavel do meu banco com o nome dos produtos antes de gerar a trigger que irá fazer isso automaticamente. Para atualizar todos os registro a sintaxe fica mais ou menos como mostrado abaixo, bastando trocar pelo nome dos seus campos e tabelas.

UPDATE tabelaProduto SET campo_url_amigavel = urlAmigavel(campo_nome_produto) WHERE campo_url_amigavel IS NULL

Dessa forma iremos atualizar os produtos já existentes. No meu caso as url’s ficam separadas em uma tabela e o nome do produto fica em outra tabela, mas por essa query vocês podem entender o funcionamento e adaptar para as suas necessidades.

Agora vamos criar a TRIGGER no evento BEFORE INSERT, ou seja, toda vez que um novo produto for cadastrado.

DELIMITER $$
CREATE TRIGGER trgGeraUrlAmigavel BEFORE INSERT ON tabela_produto
FOR EACH ROW
BEGIN
	IF(NEW.campo_url_amigavel IS NULL) THEN
		SET NEW.campo_url_amigavel = urlAmigavel(NEW.campo_nome_produto);
	END IF;
END$$

Conforme pode ser visto na trigger, é validado se o campo veio nulo, caso sim, insere o retorno da função para ser inserido como valor para a url amigável.

Espero que tenham gostado do post, qualquer sugestão, dúvida ou até crítica sobre o conteúdo, fiquem a vontade para comentar, a medida do possível vou respondendo os comentário. Toda contribuição é válida.

Caso tenha uma sugestão para novos posts sobre MySql, ORACLE, PHP, CSS, Ajax ou Jquery por favor mandem e-mail para blog@roberson.com.br que se eu tiver domínio do assunto em questão, com certeza irei criar um post sobre, e se não tiver domínio sobre o assunto, provavelmente vou estudar sobre e postar meus comentários, quem saber até um post mais complexo.

Até o próximo post.

Posts relacionados:

1. Validando dados inseridos no banco MySql – Parte 02
2. Validando dados inseridos no banco MySql – Parte 01

-- --------------------------------------------------------------------------------
-- Routine DDL
-- --------------------------------------------------------------------------------
DELIMITER $$

CREATE DEFINER=`root`@`localhost` FUNCTION `validarCpf`(CPF CHAR(11)) RETURNS double
BEGIN
	DECLARE INDICE INT;
	DECLARE SOMA INT;
	DECLARE DIG1 INT;
	DECLARE DIG2 INT;
	DECLARE CPF_TEMP VARCHAR(11);
	DECLARE DIGITOS_IGUAIS CHAR(1);
	DECLARE RESULTADO CHAR(1);

	SET RESULTADO = FALSE;

	/*
	Verificando se os dígitos são iguais
	A Principio CPF com todos o números iguais são Inválidos
	apesar de validar o Calculo do digito verificado
	EX: O CPF 00000000000 é inválido, mas pelo calculo
	Validaria
	*/

	SET CPF_TEMP = SUBSTRING(CPF,1,1);

	SET INDICE = 1;
	SET DIGITOS_IGUAIS = 'S';

	WHILE (INDICE <= 11) DO
		IF (SUBSTRING(CPF,INDICE,1) <> CPF_TEMP) Then
			SET DIGITOS_IGUAIS = 'N';
		END IF;
		SET INDICE = INDICE + 1;
	END WHILE;

	/*Caso os dígitos não sejam todos iguais Começo o calculo do dígitos*/
	IF (DIGITOS_IGUAIS = 'N') THEN
		/*Cálculo do 1º dígito*/
		SET SOMA = 0;
		SET INDICE = 1;
		WHILE (INDICE <= 9) DO 			SET Soma = Soma + CAST(SUBSTRING(CPF,INDICE,1) AS UNSIGNED) * (11 - INDICE); 			SET INDICE = INDICE + 1; 		END WHILE; 		SET DIG1 = 11 - (SOMA % 11); 		IF (DIG1 > 9) THEN
			SET DIG1 = 0;
		END IF;

		-- Cálculo do 2º dígito }
		SET SOMA = 0;
		SET INDICE = 1;
		WHILE (INDICE <= 10) DO 			SET Soma = Soma + CAST(SUBSTRING(CPF,INDICE,1) AS UNSIGNED) * (12 - INDICE); 			SET INDICE = INDICE + 1; 		END WHILE; 		SET DIG2 = 11 - (SOMA % 11); 		IF DIG2 > 9 THEN
			SET DIG2 = 0;
		END IF;

		-- Validando
		IF (DIG1 = SUBSTRING(CPF,LENGTH(CPF)-1,1)) AND (DIG2 = SUBSTRING(CPF,LENGTH(CPF),1)) THEN
			SET RESULTADO = TRUE;
		ELSE
			SET RESULTADO = FALSE;
		END IF;

	END IF;
	RETURN RESULTADO;
END

Executando esse código naquela nossa base de testes (download e leitura da parte 01) a função validaCpf() vai ser criada no seu banco de dados, para executar a função basta executar um SELECT normal chamando a função validaCpf(), como no exemplo abaixo.

SELECT validarCpf('02452345798') FROM dual

Nesse caso irá retornar 0(zero) que corresponde a false/falso, caso você coloque um cpf válido no teste ele irá retornar 1(um) que corresponde a true/verdadeiro. Sendo assim agora basta colocarmos na nossa trigger essa chamada para a validação.

-- Trigger DDL Statements
DELIMITER $$

USE `testes_roberson`$$CREATE DEFINER=`root`@`localhost` TRIGGER trgValidacaoEmail BEFORE INSERT ON clientes
FOR EACH ROW BEGIN
    -- Declaro variável para identificar se está válido ou não
    DECLARE email DOUBLE DEFAULT FALSE;
    DECLARE cpf DOUBLE DEFAULT FALSE;

    -- Verificar se e-mail é válido
	IF (NOT EXISTS (SELECT NULL FROM Clientes WHERE  NEW.Email REGEXP '^[a-zA-Z0-9]{1}([\._a-zA-Z0-9-]+)(\.[_a-zA-Z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+){1,3}$')) THEN
        -- Caso seja inválido atribuo true para a variável email
        SET email = TRUE;
	END IF;

	IF ((SELECT validarCpf(NEW.Cpf) FROM dual) = 0 ) THEN
        -- Caso seja inválido atribuo true para a variável cpf
		SET cpf = TRUE;
	END IF;

    -- Verifico se as duas variaveis (email e cpf) estão como true, e mostro o erro
	IF (email && cpf) THEN
        SELECT 0 FROM `Não foi possível inserir os dados! E-mail e CPF inválidos`INTO @error;
    END IF;
    -- Verifico se a variável email está como true, e mostro o erro
    IF (email) THEN
        SELECT 0 FROM `Não foi possível inserir os dados! E-mail inválido`INTO @error;
    END IF;
    -- Verifico se a variável cpf está como true, e mostro o erro
    IF (cpf) THEN
        SELECT 0 FROM `Não foi possível inserir os dados! CPF inválido`INTO @error;
	END IF;
END$$

Criando essa trigger ou alterando a existente do exemplo anterior, a trigger será disparada todas as vezes que algum dado for ser inserido no banco e verificará tanto e-mail quanto CPF. Eu gostaria de ter feito esse exemplo de uma maneira um pouco diferente, queria armazenar em uma variável a string com o erro a cada verificação, e ao final concatenar elas e exibir o erro, porem não consegui que o CONCAT funciona-se dentro da clausula FROM. Caso alguem consiga algo do tipo, por favor me envie que eu atualizo aqui no script, e eu também vou continuar tentando fazer essa alteração.

O exemplo php da parte 01 continua funcionando da mesma maneira, para testarmos basta mudar no insert para um cpf inválido. Quando o E-mail e/ou CPF forem inválidos o erro será mostrado.

Espero ter contribuido com algo, sugestões, criticas ou elogios são muito bem aceitos. Espero que aproveitem e sucesso a todos.

Veja também:
Validando dados inseridos no banco MySql – Parte 01

Posts relacionados:

1. Validando dados inseridos no banco MySql – Parte 01
2. Convertendo campos em url amigável pelo Mysql

Para o exemplo estou disponibilizando para download aqui o script para criação e população de um banco de dados teste (Schema testes_roberson), nos outros posts relacionados a banco de dados também irei utilizar essa base, conforme eu for modificando a base vou atualizando o script de criação e publicando uma notificação de atualização aqui mesmo no blog.

A validação que vou mostrar é bem simples, mas pode dar uma idéia de como criar validações mais completas (pretendo ir colocando aos poucos outras validações mais complexas). Neste exemplo vou mostrar como criar uma Trigger para validar E-mail.

Primeiro faça o download do arquivo .zip onde você encontrará o arquivo testes_roberson.sql e o arquivo leiame.txt(algumas refências sobre o arquivo). Execute o arquivo sql em seu SGBD(Sistema Gerenciador de Banco de Dados), eu uso o MySQL Workbench Tools onde é possível administrar, interagir e modelar bases MySQL, mas pode utilizar qualquer SGBD de sua preferência.

Com o banco, tabelas e dados já criados agora vamos para a análise de possíveis validações que podemos fazer.

Fig. 01 - Modelagem Data Base testes_roberson (schema)

Olhando as tabelas podemos concluir que:

1. Trata-se de um banco simples (para estudos) de um cadastro de clientes.
2. Podemos criar uma rotina para validar CPF, E-mail e talvez ainda o CEP (validar se veio somente numeros e se são 8 caracteres)
3. Podemos criar tabelas de Cidades e Estados para evitar duplicidade de dados.

Nosso objetivo neste post é criar uma trigger para validar e permitir somente e-mails válidos. Segue a baixo código para criação da trigger.

-- Trigger DDL Statements
DELIMITER $$

-- Selecionamos o database desejado e criamos a trigger
-- Usando o BEFORE validamos o dado antes de inserir na tabela e AFTER depois de inserir na tabela
-- INSERT significa que a trigger será disparada quando ocorrer um INSERT na tabela, pode ser usado também o UPDATE e DELETE
USE `testes_roberson`$$CREATE DEFINER=`root`@`localhost` TRIGGER trgValidacaoEmail BEFORE INSERT ON clientes
  FOR EACH ROW BEGIN
    -- Verificamos se o NEW.Email (e-mail que está vindo no INSERT) é válido segundo a expressão regular usado com a função REGEXP
    IF (NOT EXISTS (SELECT NULL FROM Clientes WHERE  NEW.Email REGEXP '^[a-zA-Z0-9]{1}([\._a-zA-Z0-9-]+)(\.[_a-zA-Z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+){1,3}$')) THEN
        -- caso entre no IF disparamos um SELECT com nome de tabela inválido descrevendo o erro que será retornado.
        SELECT 0 FROM `Erro ao inserir dados! E-mail Inválido!` INTO @error;
    -- Fechamos o IF
    END IF;
  -- Fechamos a criação da trigger
  END$$

Com isso a validação já deve estar funcionar. É possível prever uma pequena “gambiarra” (prefiro chamar de ajuste técnico) somente olhando esse script. Quando tentarmos inserir um e-mail inválido ele irá nos retornar o seguinte erro:

Error Code: 1146
Table 'testes_roberson.Erro ao inserir dados! E-mail Inválido!' doesn't exist

Este erro está nos dizendo que a tabela ‘Erro ao inserir dados! E-mail Inválido!’ não existe nessa base de dados. Isso acontece devido ao fato de o nosso querido MySQL não ter nada expecífico para tratamento de erros ou de exceção (Exception). Isso realmente é muito triste, mas pelo menos estamos notificando ao usuário/programador que o dado não foi inserido e que o erro está no e-mail. Se tivermos a possibilidade de conversar com o programador ou programar uma rotina de tratamento de erros na própria linguagem que estiver sendo usada, esse mesmo erro pode ser exibido para o usuário. Para isso basta resgatar esse erro e passar ele por uma função que retire o inicio do erro “Error Code: 1146 – Table ‘testes_roberson.Erro ao inserir dados!” e o final do erro “‘ doesn’t exist”, com isso ficaremos somente com o erro que queremos

Reconheço que o erro retornado não é a melhor coisa do mundo, mas com algumas poucas linhas podemos deixar ele mais limpos, a baixo coloco um script PHP de como poderiamos tratar esse erro e mostrar para o cliente.

//trigger_email.php
// Função para tratamento dos erros
function tratarErrosMysql($numError, $error){
	//identificamos que o erro é no nome da tabela error 1146
	if($numError == '1146'){
		//executamos a decodificação de utf8 para que o erro não apresente problemas com os acentos.
		$error = utf8_decode($error);
		//retiramos o inicio e o fim do erro.
		$error = substr($error, 23 , -15);
		//retornamos o erro que veio do banco
		return $error;
	}else{
		//caso o erro não seja no nome da tabela(retorno de nossa trigger) retornamos o erro do mysql intacto
		return $error;
	}
}
// criamos a conexão com o banco de dados no nosso caso, MySql
$conn = mysqli_connect("localhost", "root", "","testes_roberson");  

//executamos nosso comando sql
$sql = "INSERT INTO Clientes SET Cpf = '05332754906', Nome='Teste', Sobrenome='Teste', Email='isso não é um email válido',sexo='M';"; // query (comando sql)
$result = mysqli_query($conn, $sql);
//verificamos se ouve algum erro
if(mysqli_error($conn)){
	// apresentamos o erro para o cliente;
	echo tratarErrosMysql(mysqli_errno($conn),mysqli_error($conn));
}

Assim teremos o erro tratado, assim teremos uma base de dados bem mais consistente e livre de falhas de verificação na aplicação e erros dos usuários. E não esqueçam de criar uma trigger que valide o dado quando houver uma atualização BEFORE UPDATE.

Em próximos posts pretendo mostrar a validação de CPF usando trigger e stored procedure.

Posts relacionados:

1. Validando dados inseridos no banco MySql – Parte 02
2. Convertendo campos em url amigável pelo Mysql