Posted on: July 10, 2021 12:39 PM

Posted by: Renato

Categories: Laravel PHP webdev web

Views: 557

Introdução

Como você já sabe, o Laravel é o framework MVC PHP mais poderoso e mais usado para construir aplicações web completas. Com sua sintaxe expressiva e bonita e conjunto de ferramentas moderno, o Laravel é o líder na indústria. O Laravel foca primeiro no usuário final, o que significa que seu foco está na simplicidade, clareza e execução do trabalho.
Para mais informações sobre o framework Laravel, visite a página de documentação, seguindo este link .
Por todas essas vantagens do framework, estamos usando muito o Laravel, porque tendemos e nossa ideia é seguir todas as últimas tendências da indústria de TI.
Por isso, neste post, usaremos o Laravel 5.6. Você vai aproveitar!

Aplicação de esqueleto

Para o propósito deste tutorial, um aplicativo Laravel foi criado do zero com as seguintes funcionalidades:

• Funcionalidade de login / registro com o comando core auth ;
• Criou alguns usuários de teste no banco de dados;
• Controladores de posts e comentários, modelos, relações e migrações com alguns dados de amostra.

Detecção de Spam

Existe um grande problema com os spammers hoje em dia. Existem muitos scripts em execução em diferentes sites e tentam enviar um formulário onde quer que eles surjam. Você já se perguntou por quê? Se você tem um pouco de experiência com SEO, pode entender que o motivo é muito simples.
Eles tentam adicionar um link (backlink de spam) que redireciona para sites de spammers em potencial. Com isso, eles constroem autoridade em seus sites e é mais fácil classificar o site em uma posição superior na pesquisa do Google quando alguém busca por palavras-chave relacionadas ao conteúdo de seus sites. A classificação mais elevada na pesquisa do Google é calculada principalmente com base nos backlinks e na autoridade dos sites. A autoridade do site é aumentada com mais backlinks.
Este é o principal motivo pelo qual precisamos ter cuidado com spammers em nosso aplicativo, porque podemos facilmente encontrar nossos aplicativos com muitos comentários de spam que não estarão relacionados com o conteúdo do site.

Regras de spam que serão usadas

Neste tutorial, comentários de spam em postagens de blog serão detectados. Claro, existem muitas regras que podem ser apresentadas, mas por enquanto, a atenção estará em 3 regras. Esses são:

1. Palavras-chave inválidas

Este será um conjunto de palavras ou frases. Cada comentário que contiver qualquer uma dessas palavras ou frases será marcado como spam.

2. Tecla mantida pressionada

Imagine que alguém, visite seu site e apenas por diversão mantenha pressionada uma tecla e tente postar um comentário. Por exemplo: 'aaaaaaaa', 'bbbbbbbbb', etc. Devemos prevenir este tipo de ação e marcar esses comentários como spam.

3. Comentários postados com muita frequência

Devemos evitar que os usuários postem comentários com muita frequência. Haverá um parâmetro de configuração com um número inteiro que nos dirá quanto tempo o usuário deve esperar antes de postar um novo comentário.

Vamos codificar!

Com certeza, para não incomodá-lo com muitas informações desnecessárias sobre a aplicação que foi configurada para este tutorial, o foco será apenas compartilhar trechos de código com boa explicação, que sejam mais úteis e compreensíveis.
Nesta seção, mostraremos um post com o fluxo básico que é habilitado com o lindo componente HTTP Foundation que o Laravel usa.
Rota no arquivo web.php:

 

<?php

Route::get('/blog/{slug}', 'PostsController@show');

?>

Método em PostsController:

 

<?php

/**

* Show single post

*

* @param string $slug

* @return \Illuminate\Http\Response

*/

public function show($slug)

{

$post = Post::where(‘slug’, $slug)->first();

return view('blog.single_post', compact('post'));

}

?>

 

• Encontre a postagem com o slug (é um campo vunique no banco de dados);
• Retorne a vista com parâmetro do post.

Depois disso, a visualização será renderizada em um modelo de lâmina com os dados da postagem.
Na visualização, há um formulário para adicionar um comentário à postagem.
É assim na vida real:

E o formulário no modelo de lâmina (usando bootstrap 4):

 

<form action="/blog/{{$post->id}}/store-comment" method="POST">

{{ csrf_field() }}

<div class="form-group">

<textarea class="form-control" name="body" rows="3"></textarea>

</div>

<button class="btn btn-primary" type="submit">

Submit

</button>

</form>

Ao enviar, a ação do formulário é configurada para postar a solicitação para a rota fornecida. O método post é tratado assim no arquivo web.php:

 

<?php

Route::post('/blog/{post}/store-comment', 'CommentsController@store');

?>

 

 

<?php

/**

* Store new post

*

* @param App\Post $post

* @return Illuminate\Http\RedirectResponse

*/

public function store(Post $post)

{

try {

resolve(Spam::class)->detect(request('body'));



$post = Post::find($post->id);



$post->comments()->create([

'user_id' => auth()->id(),

'body' => request('body'),

]);



return redirect("/blog/{$post->url}#comments")->with([

'status' => 'success',

'message' => 'Your comment was published successfully',

]);

} catch (Exception $e) {

return redirect("/blog/{$post->url}#comments")->with([

'status' => 'danger',

'message' => $e->getMessage(),

]);

}

}

?>

 

Explicação do código acima:

• Encontrar a postagem por ID na qual o usuário deseja comentar;
• Criando o comentário (observe a relação);
• Redirecione para a postagem anterior com um status e uma mensagem.

Espero que até agora tudo esteja claro. Agora vem a parte interessante.
Será criada uma classe de spam dedicada que tratará de tudo relacionado à detecção de comentários de spam. Claro, vamos criá-lo seguindo as melhores práticas e mantendo a regra de separação de interesses.
Vamos criar uma classe Spam genérica:

 

<?php



namespace App\Inspections;



class Spam

{

/**

* All registered inspections

*

* @var array

*/

protected $inspections = [

InvalidKeywords::class,

KeyHeldDown::class,

CommentsPostedVeryOften::class,

];



/**

* Detect spam

*

* @param string $body

* @return bool

*/

public function detect($body)

{

foreach ($this->inspections as $inspection) {

app($inspection)->detect($body);

}



return false;

}

}

 Deixe-me explicar o código acima:

• A classe Spam é criada e colocada na pasta App \ Inspections;
• Na propriedade $ inspections, em um array são colocadas todas as classes com regras específicas que foram separadas durante a refatoração do código;
• Abaixo, no método detect (), o corpo do comentário é passado e percorre todas as classes na propriedade $ inspections, passando o nome da classe para o auxiliar app () para resolvê-lo no contêiner e chamando cada detect de classe () método com um parâmetro que é o corpo do comentário (tipo string).

Você pode ver que cada regra de spam é separada em classes diferentes. Todas as classes são colocadas na pasta App \ Inspections.
Então, vamos falar sobre cada aula e explicar o que exatamente elas estão fazendo.

Regra de palavras-chave inválidas

Este é o código para esta aula:

 

<?php



namespace App\Inspections;



use Exception;



class InvalidKeywords

{

/**

* All spam keywords

*

* @var array

*/

protected $keywords = [

'customer support',

];



/**

* Detect spam

*

* @param string $body

* @throws \Exception

*/

public function detect($body)

{

foreach ($this->keywords as $keyword) {

if (stripos($body, $keyword) !== false) {

throw new Exception("Your comment contains spam.");

}

}

}



}

• Inicializando uma propriedade $ keywords que é uma matriz de todas as palavras-chave que reconhecemos como spam. Por enquanto, há apenas uma palavra-chave, mas você pode escrever quantas forem necessárias;
• O método detect () chamado da classe Spam com o parâmetro $ body passado da classe Spam também;
• Loop através da propriedade $ keywords, e para cada uma das palavras-chave, há uma verificação se a palavra-chave existe no corpo do comentário e, em caso afirmativo, lança uma Exceção.

Simples assim.

Regra de tecla pressionada

Este é o código para esta aula:

 

<?php



namespace App\Inspections;



use Exception;



class KeyHeldDown

{

/**

* Detect spam

*

* @param string $body

* @throws \Exception

*/

public function detect($body)

{

if (preg_match('/(.)\\1{4,}/', $body)) {

throw new Exception("Your comment contains spam.");

}

}

}

• O método detect () chamado da classe Spam com o parâmetro $ body passado da classe Spam também;
• Verificar com expressão regular se o corpo do comentário contém a mesma letra em uma linha mais de 4 vezes. É 4 vezes para os fins deste exemplo, você pode alterá-lo de acordo com suas necessidades;
• Se a condição for atendida, lance Exception.

Os comentários postados costumam reger

Este é o código para esta aula:

 

<?php



namespace App\Inspections;



use App\User;

use Carbon\Carbon;

use Exception;



class CommentsPostedVeryOften

{

/**

* Detect spam

*

* @param string $body

* @throws \Exception

*/

public function detect($body)

{

$user = User::find(auth()->id());



$latestComment = $user->getLatestCommentByUser();



if ($latestComment) {

$data = $this->prepareCommonData($latestComment);



if ($user->canUserPostComment($data)) {

throw new Exception("You can post only once in {$data["userCommentFrequency"]} minutes.");

}

}

}



/**

* Prepare common data

*

* @param Collection $latestComment

* @return array

*/

public function prepareCommonData($latestComment)

{

return [

'latestCommentCreated' => new Carbon($latestComment->created_at),

'userCommentFrequency' => config('app.spam_detection.user_can_comment_once_in'),

];

}

}

• O método detect () chamado da classe Spam com o parâmetro $ body passado da classe Spam também;
• Encontrar o usuário conectado;
• Obter o comentário mais recente do usuário conectado;
  • O código é separado em um método getLatestCommentByUser () declarado no modelo de usuário:

 

<?php

/**

* getLatestCommentByUser - get latest comment by user

*

*/

public function getLatestCommentByUser()

{

return $this->comments()->latest()->first();

}

?>

 

• Se o usuário tiver comentários, existe uma condição que verifica se o usuário pode postar um novo comentário com outro método canUserPostComment () declarado no modelo do usuário e passou um dado preparado com a data do último comentário criado e um parâmetro de configuração do arquivo app.php que nos informa com que frequência um usuário pode postar um comentário. Por enquanto, é uma vez em 10 minutos.
  • Abaixo está o código do método canUserPostComment ():

 

<?php

/**

* Check if user can post comment

*

* @param string $data

* @return bool

*/

public function canUserPostComment($data)

{

return $data['latestCommentCreated']->diffInMinutes() < $data['userCommentFrequency'];

}

?>

• Se o usuário postar um comentário em menos de 10 minutos, a condição é atendida e o código lança Exceção com uma mensagem adequada.

Existe apenas uma e última etapa antes de concluir este recurso. Para chamar a classe Spam e detectar se o comentário é spam em todas as regras de spam, você deve adicionar mais uma linha de código no método store () do CommentsController. Esta é a linha do código:

 

<?php

resolve(Spam::class)->detect(request('body'));

?>

E depois disso, o método store () ficará assim:

 

<?php

/**

* Store new post

*

* @param App\Post $post

* @return Illuminate\Http\RedirectResponse

*/

public function store(Post $post)

{

try {

resolve(Spam::class)->detect(request('body'));



$post = Post::find($post->id);



$post->comments()->create([

'user_id' => auth()->id(),

'body' => request('body'),

]);



return redirect("/blog/{$post->url}#comments")->with([

'status' => 'success',

'message' => 'Your comment was published successfully',

]);

} catch (Exception $e) {

return redirect("/blog/{$post->url}#comments")->with([

'status' => 'danger',

'message' => $e->getMessage(),

]);

}

}

?>

 

Conclusão

O exemplo neste post é uma solução simples e fácil de implementar. Claro, como mencionado acima, existem muitas outras regras que você pode adicionar e, com essa estrutura de código, será muito fácil adicionar uma nova regra com base em suas necessidades.
Você pode ver como é agradável programar com o framework Laravel, é por isso que o Laravel é preferido e recomendado para todos os tipos de aplicações web, desde simples projetos de hobby até empresas Fortune 500.
Fique à vontade para comentar abaixo e compartilhar suas idéias.