[ABD] Akismet Spam Butcher 0.1.0

A place for MOD Authors to post and receive feedback on MODs still in development. No MODs within this forum should be used within a live environment! No new topics are allowed in this forum.
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

IMPORTANT: MOD Development Forum rules

On February 1, 2009 this forum will be set to read only as part of retiring of phpBB2.
User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

[ABD] Akismet Spam Butcher 0.1.0

Postby webmacster87 » Wed May 24, 2006 2:03 am

MOD Title: Akismet Spam Butcher
MOD Description: Integrates phpBB with the Akismet spam-catching service so that spam posts on your forum can get checked and tagged by Akismet. Requires a WordPress.com API key.
MOD Version: 0.1.0

MOD Download: http://prdownloads.sourceforge.net/foamods/akismetspambutcher_010.zip?download
Latest Stable version: N/A

Subversion Access: You can checkout a working copy of Akismet Spam Butcher via this command:

Code: Select all

svn checkout https://svn.sourceforge.net/svnroot/foamods akismetspambutcher_dev

Note that Subversion contains the latest edits to the MOD, and therefore are not guaranteed to be complete, secure, or bug-free. You should only use data in Subversion if you know what you're doing. More information available on the SF.net Subversion Page.

**************************************
Author's Notes for This Release
Akismet Spam Butcher 0.1.0, the "Happy Anniversary, Mom and Dad!" edition, has been released!
This release is still marked as [DEV] because the MOD doesn't exactly "do" anything yet. All that this MOD does so far is add an admin panel to enter your WordPress.com API Key and check each submitted post for spam. However, the check doesn't _do_ anything yet. Akismet will check each and every post to see if it is spam, and it will be tagged in the phpbb_topics and/or the phpbb_posts table as being spam or not, however regardless of what Akismet thinks, the post will still be displayed as usual. Hey, I said the MOD was still in development! ;) The next release will introduce the Spam Queue so that posts marked as spam will not be displayed but instead listed in a queue in the Admin Control Panel.

I have tested what there is in this MOD with phpBB 2.0.21, and hopefully spam gets checked and marked correctly. If anything isn't working as expected, please let me know by replying to the topic. I am hoping that some people familiar with Akismet can look at this and give any opinions/suggestions regarding the implementation.

I'm planning for the next release, 0.1.1, to come out towards the end of June. Why so long? I'm leaving on Monday for a one-week trip to Austria, and won't be back until the 26th (and sorry, I'm not taking my laptop with me!). I'm going to begin working on 0.1.1 when I get back.

Thanks for testing Akismet Spam Butcher!
**************************************

Ever since I started using the Akismet spam-catching service on my blog, it has become a godsend. No more do I have to close up trackbacks and comments to registered users to keep out the spam; Akismet catches it for me. But why does this have to be limited to blogs? After all, forums which allow guest posting are also subject to spam, unless they install one of those MODs that require a user to type in a VC code every time they post. But who really wants to deal with that?

Akismet Spam Butcher finally brings together the pair that was meant for each other: Akismet and phpBB (yes, Akismet already had a relationship with WordPress, but in the world of technology, multiple relationships are good things!). :P

About Akismet:
For those of you that a) Don't have a WordPress blog, or b) Have a WordPress blog but don't use Akismet (and really should), here's a quick rundown of how Akismet works. You make a post, or comment to a blog entry. The entry is then checked against Akismet's HUGE database of spamming algorithms, etc., to see if it can be classified as spam. If it looks okay, the post is made as usual. If it's classified as spam, then the post is not made, but it is set aside.
No system is perfect, but Akismet learns from its mistakes. If a post that is actually spammy gets through, you can mark it as spam, and Akismet will make a note of it for later. Conversely, if a legitimate post (aka ham) is marked as spam, it can be "unmarked" from that by an administrator, and, again, Akismet will learn from its mistake.
All you need to use Akismet is a WordPress.com API key, which you get by signing up for an account at WordPress.com. WordPress.com also recently made it so you aren't obligated to set up an abandon-blog when you register, which is perfect if you just want to get an API key. Once you have a key, you can start using Akismet for free (noncommercial purposes).
More info available from Akismet's website.

About this MOD:
This MOD will mostly be an adaptation of the Akismet WordPress plugin for phpBB. When you enter your API key for the Akismet Spam Butcher MOD, you can choose to enable Akismet spam checking for all posts, only posts by guests, or completely disable it. When spam checking takes place, a post will be evaluated by Akismet. If it checks out as ham (clean), it will be posted like usual. If it checks out as spam, the post will still be added to the database but it will be hidden from view, and added to a Spam Queue in the ACP. From that Spam Queue, all the spam posts can be reviewed and either marked as Not Spam or deleted. Optionally, posts can also be automatically deleted in a set period of time from the queue. There will also be a button on each post for a moderator/administrator to mark a post as spam.

The phases of development for this MOD will be as follows (an alpha/beta release will occur at the end of each phase):
Phase 1: Implementation of Akismet checking for all posts (nothing happens to spam yet) -- Done! Version 0.1.0
Phase 2: Implementation of the Spam Queue
Phase 3: Completion of Configuration Options, including ability to have spam in the Spam Queue automatically delete
Phase 4: Ability to mark clean posts as spam, any other code cleanup/features
Note that these phases are only a blueprint for development and not binding.

phpBB3 Olympus:
Akismet Spam Butcher will be the first of my MODs to offer support for phpBB3 Olympus. This is really exciting not only for Olympus users, who will be able to take advantage of Akismet Spam checking right from the start, but also exciting for me, as it will give me an opportunity to become familiar with the code in Olympus (which is 100% different from phpBB2's code!). I will be working on the Olympus release simultaneously with the phpBB2 release, however the Olympus release will not be formerly released until Olympus' first release candidate (it will be in SVN however). Akismet Spam Butcher will be submitted to the MOD Database when the MOD Team starts accepting MODs for Olympus or when this MOD is completed, whichever comes later.

Advanced Version Check:
This MOD is compatible with my Advanced Version Check MOD which will allow you to track development and can notify you when a new release of Akismet Spam Butcher is available.


Enjoy Akismet Spam Butcher!
--Fountain of Apples
Last edited by webmacster87 on Sun Aug 13, 2006 8:58 pm, edited 4 times in total.

User avatar
Wo1f
Registered User
Posts: 2039
Joined: Fri Jan 28, 2005 3:20 am

Postby Wo1f » Wed May 24, 2006 3:43 am

Hi Fountain of Apples,

And a nice example for us noobie coders on how to plan and organize the development process of a sizable project. First thing that comes to mind concerning high-traffic forums is the bandwidth issue. For example:
  • What kind of an impact are we talking about?
  • What should I expect from the moment I hit the "submit" button as a posting member (transparency or increased latency so to speak)?

Regards,
Wolf

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Wed May 24, 2006 3:45 am

Not sure yet as I haven't started coding the MOD yet. However, it should probably be similar to the amount of time it takes to post a comment on a WordPress blog with Akismet enabled (most blogs on WordPress.com are like this). From my experience, Akismet is fairly quick and low bandwidth.

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Wed May 31, 2006 12:32 am

Added information regarding Subversion access. See first post for more info.

User avatar
markus_petrux
Former Team Member
Posts: 1887
Joined: Wed Apr 23, 2003 7:11 am
Location: Girona, Catalunya (Spain)
Contact:

Postby markus_petrux » Mon Jun 05, 2006 7:02 pm

I'm glad someone thought about akismet for phpBB.

Keep up! ;)
EasyMOD Standards | MOD Template Actions | MODs in Development Rules
Useful information for MOD Authors | MOD Queue Stats | Search MODs
Write SQL/DDL portable to all SQL servers supported by phpBB!
Get EasyMOD 0.3.0! | Suport al phpBB en Català!
8)

FiReaNG3L
Registered User
Posts: 6
Joined: Wed Mar 09, 2005 12:05 am

Postby FiReaNG3L » Mon Jun 05, 2006 11:06 pm

Hey there,

Just to let you know, I already implemented a hack for Akismet support in phpBB (well, for my movable type / phpBB hybrid comment system, but everything is handled by phpBB anyway). Its working #1; no more spam and no false positives!

It's currently in action at http://www.biologynews.net .

I just added a new field to the posts database (is_spam), check for spam when a new comment is posted, and added is_spam != 1 on strategic sql queries for non-admins (so no one see spam except you), a check spam and a delete all spam feature, and a report as not spam. Missing feature: mark as spam (currently I just delete spammy comments which make it past the filter - very few). I'm not sure that my report as spam / ham implementation is correct either.

I used the excellent PHP 5 class by alex (available on akismet website)

If you want to have access to my files (to get inspiration or something) just let me know, as I don't have the time to make an official mod out of it (being at the PhD = not much spare time). Contact me at hotmail (with my nickname) or by private message on this board if it supports this feature!

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Mon Jun 05, 2006 11:11 pm

I've already gotten a good deal of code together, but thanks for the offer.

I'm hoping to make an initial alpha release sometime this week.

billsaysthis
Registered User
Posts: 16
Joined: Wed Jul 27, 2005 5:34 pm
Contact:

Postby billsaysthis » Tue Jun 13, 2006 4:32 pm

Any news yet on the Akismet mod? I'd really like to use it.

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Tue Jun 13, 2006 5:32 pm

I'm currently having some issues with my computers. As soon as I get everything back together, I will get back into updating Subversion.

The first alpha release will be out as soon as a basic implementation of Akismet is complete, hopefully by the end of the week.

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Wed Jun 14, 2006 12:43 am

UPDATE: I'm now back on track with working on Akismet Spam Butcher. I have completed and committed to Subversion the Akismet checks for new posts/topics. This doesn't _do_ anything except internally mark the post as spam, however this won't cause any noticable effect untilthe first alpha release (one step at a time).

The first dev release will be ready after I finish putting together a basic configuration panel for entering your WordPress.com API Key. I have a goal of releasing Akismet Spam Butcher 0.1.0 tomorrow. :)
--Fountain of Apples

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Thu Jun 15, 2006 6:38 pm

Akismet Spam Butcher 0.1.0, the "Happy Anniversary, Mom and Dad!" edition, has been released! See first post for more info and download link.

billsaysthis
Registered User
Posts: 16
Joined: Wed Jul 27, 2005 5:34 pm
Contact:

Postby billsaysthis » Thu Jun 15, 2006 6:49 pm

There seems to be a problem with the SF download link, if I pick a mirror I get a bad mirror error and just clicking the file link gets me a 404.

User avatar
webmacster87
Former Team Member
Posts: 3758
Joined: Fri Jun 11, 2004 2:30 am
Location: San Mateo, CA
Name: Douglas Bell
Contact:

Postby webmacster87 » Thu Jun 15, 2006 6:55 pm

billsaysthis wrote:There seems to be a problem with the SF download link, if I pick a mirror I get a bad mirror error and just clicking the file link gets me a 404.

It takes some time for the file to propagate through SF.net's mirrors. I prefer that you use SourceForge if possible, but for quick and dirty access you can use this temporary download link.

billsaysthis
Registered User
Posts: 16
Joined: Wed Jul 27, 2005 5:34 pm
Contact:

Postby billsaysthis » Thu Jun 15, 2006 7:04 pm

No rush, I can wait. Just thought it might be a problem worth mentioning.

User avatar
markus_petrux
Former Team Member
Posts: 1887
Joined: Wed Apr 23, 2003 7:11 am
Location: Girona, Catalunya (Spain)
Contact:

Postby markus_petrux » Thu Jun 15, 2006 7:05 pm

This is looking very good! :)

One thing I would like to suggest: if at all possible, at some point in time, could you please add an option to select one user group that is exempt from spam checks? That way trusted users could be assigned to such group while the rest are still subject to the akismet hammer.

Thanks and happy break! ;)
EasyMOD Standards | MOD Template Actions | MODs in Development Rules
Useful information for MOD Authors | MOD Queue Stats | Search MODs
Write SQL/DDL portable to all SQL servers supported by phpBB!
Get EasyMOD 0.3.0! | Suport al phpBB en Català!
8)


Return to “[2.0.x] MODs in Development”

Who is online

Users browsing this forum: No registered users and 1 guest