dmAkismetPlugin

• In a console, from your project root dir, run:

git clone git://github.com/jeremyfa/dmAkismetPlugin.git plugins/dmAkismetPlugin  

• In config/ProjectConfiguration.class.php, add dmAkismetPlugin to the list of enabled plugins:

class ProjectConfiguration extends dmProjectConfiguration
{  
  public function setup()  
  {  
    parent::setup();  
 
    $this->enablePlugins(array(  
      // your enabled plugins  
      'dmAkismetPlugin'  
    ));  

• In a console, from your project root dir, run:

php symfony dm:setup  

Activate Akismet for a model

As this plugin is intended to check if your model's record get spammed, the first thing to do is to declare that a model acts as DmAkismet.

In this documentation we will assume we have a Comment model.
Note: dmAkismetPlugin needs your model to have an "is_active" field.

schema.yml

Comment:  
  actAs:  
    DmAkismet:  
  columns:  
    is_active:  
    name:    { type: string(255), notnull: true }  
    email:   { type: string(255), notnull: false }  
    website: { type: string(255), notnull: false, extra: link }  
    body:    { type: clob, notnull: true }  

Then, run doctrine migrations and update the model. In a console, from your project root dir, run:

php symfony doctrine:generate-migrations-diff  
php symfony doctrine:migrate  
php symfony dm:setup  

Api key

In order to use akismet, you have to add your akismet api key (get one on http://akismet.com).

Add this configuration into both
apps/front/config/app.yml
and
apps/admin/config/app.yml

all:  
  akismet:  
    api_key: 205784-this-is-a-dummy-api-key  

How does it work?

dmAkismetPlugin is using the php5 akismet port written by Alex Potsides and the akismet service.

The DmAkismet Doctrine behaviour adds an "is_not_spam" field. The field is set to true by default (that means it's not a spam).

Typical situation
A user is posting a new comment. When the comment's save() method is called, the model is asking the akismet service if it is spam or not.

If akismet tells this is a spam, the record is still saved into database but its "is_active" and "is_not_spam" fields will be set to false and the comment will not be shown on front.

Later, the administrator can go to the admin panel and completely delete the comment as he would do for another comment.

If akismet made a mistake (it marked a comment as spam when it's not), the administrator just has to set the record's "is_not_spam" field to true and re-active the comment. It will notify akismet that the comment is not a spam.
In contrary, if akismet didn't mark a comment as a spam when it should have done it, the administrator just has to mark the record's "is_not_spam" field to false, and the akismet service will be notified that this is a spam (he can also disable the comment or delete it after).

Default field names

dmAkismetPlugin is trying to use the most common field names in order to guess which field in the model is the author's name, wich one is the message etc... Here is a list of the default recognized field names.

"Author Name" recognized fields:
author_name, author, name, user_name, username, user

"Author Email" recognized fields:
author_email, author_mail, email, mail

"Author Url" recognized fields:
author_url, author_website, author_link, author_blog, url, website, link, blog

"Content" recognized fields:
content, body, data, description, text, comment, message

If you are using other field names for theses informations, you can add some options to the DmAkismet behaviour in your schema.yml and the plugin will use those names instead of the default ones:

Comment:  
  actAs:  
    DmAkismet:  
      author_name:    nickname  
      author_email:   mel  
      author_url:     portfolio  
      content:        story  
  columns:  
    is_active:  
    nickname:  { type: string(255), notnull: true }  
    mel:       { type: string(255), notnull: false }  
    portfolio: { type: string(255), notnull: false, extra: link }  
    story:     { type: clob, notnull: true }  

If you want to read more complex data (for example the author name is stored in another record), you can add a getAkismet() method into your model class and do what you want:

public function getAkismetData()
{  
  // Note: remember that this code is gonna be executed when the record is not saved yet.  
  return array(  
    'author_name' => $this->getAuthor()->getFirstname().' '.this->getAuthor()->getLastname(),  
    'author_email' => $this->getEmail(),  
    'author_url' => $this->getBlog()->getUrl(),  
    'content' => $this->description  
    );  
}  

Use DmAkismet with DmCommentPlugin

DmAkismetPlugin can work with DmCommentPlugin. You just have to follow those instructions:

Add this code to your config/doctrine/schema.yml

DmComment:  
  actAs:  
    DmAkismet:  

Now copy plugins/dmCommentPlugin/modules/dmCommentAdmin/config/generator.yml to apps/admin/modules/dmCommentAdmin/config/generator.yml and modify the copied file to add the "is_not_spam" field in the list display, filter display and form display options like this:

generator:  
  class: dmAdminDoctrineGenerator  
  param:  
    ...  
    config:  
      actions: ~  
      fields:  
        ...  
      list:  
        display:  
          - ...  
          - is_active  
          - is_not_spam  
          - created_at  
          - updated_at  
        ...  
      filter:  
        display:  
          - id  
          - is_active  
          - is_not_spam  
          - ...  
      form:  
        display:  
          NONE: [..., is_active, is_not_spam]  
          ...  

Then, run doctrine migrations and update the model. In a console, from your project root dir, run:

php symfony doctrine:generate-migrations-diff  
php symfony doctrine:migrate  
php symfony dm:setup  

That's all.

TODO

• Add isSpam() and isNotSpam() methods to the model
• Add a symfony task to delete all comments marked as spam [older than x days]