Intégrer Akismet dans Symfony 1.4

Blog de Florent Viel
, at 10 January 2012

Bonjour à tous!

Aujourd’hui je vais parler de l’intégration de Akismet dans Symfony 1.4 afin de réduire le spam sur ses commentaires. Si vous avez un blog wordpress vous devez sûrement savoir ce qu’est Akismet, sinon je vous invite à visiter le site officiel ici.

Tout d’abord, il va falloir créer un compte pour récupérer une clé d’API. Pour le développement j’ai choisi le plan “Personal” à 0€, mais si votre site fait du profit ou si vous faites la promotion d’un produit dessus vous devrez souscrire à une offre payante.

Une fois votre compte créé, vous recevez un mail avec votre clé API et vos informations personnelles. Conservez bien cette clé. Maintenant, on va passer à l’intégration dans symfony. C’est assez simple, vu qu’il y a déjà un plugin de disponible à cette adresse. Donc je vous laisse télécharger le plugin et l’extraire dans le répertoire plugins/ de votre projet symfony. Et ensuite bien renommer le dossier du plugin en “drAkismetPlugin”.

On va d’abord commencer par la configuration, donc ouvrez le fichier akismet.yml.example dans le sous-répertoire config/ du plugin et enregistrez le en akismet.yml.

akismet:
  user_agent:
    application:
      name: drAkismetPlugin
      version: 0.3.2
    plugin:
      name: Akismet
      version: 1.1

  api_keys:
    www.example.com: ############
    localhost: #host utilisé pour le dev
      host: www.example.com
      key: ############

Maintenant le plugin configuré, il faut activé le plugin dans le fichier config/projectConfiguration.class.php.

<?php

$this->enablePlugins('drAkismetPlugin');

Maintenant que le plugin est activé et disponible, il faut se poser la question de comment on va l’intégrer à notre application. Pour ça il y a plusieurs possibilité, la plus simple c’est d’utiliser le sfValidator fourni avec le plugin. Il y a d’autres possibilité, mais je vais décrire l’intégration avec le validateur. Nous verrons les autres pour signaler à Akismet un Spam ou un Ham dans l’administration.

Donc pour utiliser le validateur, rien de plus simple, il s’utilise comme un validateur symfony classique. Ouvrez le form de votre projet et allez dans la méthode configure().

<?php

$this->validatorSchema['text'] = new sfValidatorAnd(array( //text est le contenu du commentaire, adaptez à votre modèle
  $this->validatorSchema['text'],
  new drAkismetValidatorSpam(array(
    'blog' => 'http://www.example.com',
    'user_ip' => $_SERVER['REMOTE_ADDR'],
    'referrer' => (array_key_exists('HTTP_REFERER', $_SERVER) ? sfContext::getInstance()->getRequest()->getReferer() : sfContext::getInstance()->getRequest()->getUri()),
    'comment_author' => 'John Doe', //Nom de l'auteur du commentaire
    'comment_author_email' => 'john.doe@example.com', //Email de l'auteur du commentaire
    'comment_content' => $this->getValue('text')
  ))
));

Et voilà, maintenant dès que vous posterez un commentaire, si Akismet le déclare comme spam, le formulaire ne sera pas valide et le commentaire ne sera pas sauvegardé.

Maintenant on peut se dire qu’on a besoin de faire un peu plus que ne pas sauvegarder le commentaire. C’est possible, on peut écouter la requête avant qu’elle soit envoyée à Akismet et récupérer la réponse avant qu’elle ne soit traitée par le validateur. Pour ça j’ai du faire une petite modification du plugin pour qu’il récupère le dispatcher d’événement de l’application au lieux d’en créer un nouveau. Ouvrez le fichier lib/api/connection/drAkismetApiSocketConnection.class.php et remplacez le contenu du constructeur pa ça :

<?php
$this->_dispatcher = sfContext::getInstance()->getEventDispatcher();

Donc maintenant le dispatcher est connecté à symfony, il faut ensuite récupérer l’événement pour indiquer quelle méthode va l’écouter :

<?php
$this->dispatcher->connect('akismet.pre_request', array('listenToPreRequest'));
$this->dispatcher->connect('akismet.raw_response', array('listenToRawResponse'));

Maintenant qu’on écoute les événements et qu’on a défini les méthodes qui vont les traiter voici quelques méthodes utiles pour parser la réponser qu renvoit le serveur.

<?php
public static function listenToRawResponse(sfEvent $event)
{
  $rawResponse = new drAkismetApiResponse($event['response']);
}

Voilà voilà, à votre tour d’intégrer Akismet à votre projet Symfony. Si vous avez des retours, n’hésitez pas à utiliser les commentaires.

Si vous trouvez une typo, n'hésitez pas à forker et éditer cet article. Merci beaucoup !

Licence Creative Commons
“Intégrer Akismet dans Symfony 1.4” de Florent Viel est mis à disposition selon les termes de la licence Creative Commons Attribution - Pas d’Utilisation Commerciale 4.0 International.


Je suis Développeur, passionné de nouvelles technologies. Je travaille acutellement pour Xotelia, un gestionnaire de canaux de vente en SaaS.

comments powered by Disqus