End-User Options - LAM - Profanity Filter

This product will mask out rude words on your forum, but with an option that allows the filter to be turned off by the user.

The filter works on all forum posts, threads, titles, search results and emails. There is also a BLOGs version of this product which I've extended to also filter the built-in blogs, comments, latest bits and titles. Blog support is not 100% complete yet. There are some places where no suitable hooks exist for the filter to work; blog search results being an example. Hopefully these will be fixed as and when more hooks become available. (I'd rather wait for the hooks then start giving instructions on hacking the files)

As of version 4.0.8.2 it is now possible to set a minimum age required before a user is allowed to turn off the profanity filter.

Installation

1. Download the required .xml file
   product-LAM_product-LAM_ProfanityFilter.xml or product-LAM_ProfanityFilterBLOG.xml
2. Install the product
   AdminCP -> Plugins & Products -> Add/Import Product -> Import Product
3. Create the required User Profile Field
   A picture speak a thousand words....
   
   ...but here are the words as well!
   

   In your Admin Control Panel (ACP), please do the following:
   
   ACP -> User Profile Fields -> Add New User Profile Field
   
   Change the "Profile Field Type" to "Single-Selection Radio Buttons" and press "Continue"
   
   Now enter the following values into the following fields...
   
   User Profile Field
   ------------------
   
   Title = Profanity Filter
   Description = The profanity filter will mask out mature language from forum posts
   Profile Field Category = (Uncategorized)
   Options = {Copy and paste in the two lines below}
   Turn On
   Turn Off
   Set Default = Yes
   Display Order = You Select this (dependant on how many you already have)
   Field Required = No
   Field Editable by User = Yes
   Private Field = Yes
   Field Searchable on Members List = No
   Show on Members List = No
   
   Optional Input
   --------------
   
   Allow user to input their own value for this option = No
   Max length of allowed user input = 100
   Field Length = 25
   Regular Expression = {Leave this Blank}
   
   
   Display Page
   ------------
   
   Which page displays this option? = Edit Profile
   
   Make a note of the FieldID at the top of the page because you will need to use it to configure this product.
   
   Press Save

4. Configure the product

Configuration

You need to configure the product to specify the Profile Field ID to use (the one created during installation). If you want to change the "Turn On" "Turn Off" labels in the profile field (e.g. for translations) then you need to change the default "Turned Off" Selection option. This product works on the basis that the filter is always on unless the user chooses to turn it off. Therefore it needs to know what to look for to determine the user has turned it off. Next is the filter mask. This is the replacement for any words which have been filtered. And finally is the list of words to filter. I've masked them out in the picture below just in case vB.org get upset.



Each user can then turn the filter off in their user cp...




Example

A user who has the profanity filter turned off can create and view posts without any alterations being made to them. For users with the profanity filter turned on this product should mask out the configured words where ever they may appear on your forum.

Here are some examples of the filter at work...










Known Issues

• Blog search results are not filtered
• Latest blog/comments AJAX results are not filtered

Version History

4.1.4.0 - Fixed bug which could display a no permission error when trying to create a new blog post (2011/07/05)
4.1.1.0 - Fixed HTML clobbering when filtering the word "ass" again (2011/01/17)
4.1.0.2 - Fixed vB4.0.1 not filtering search results post titles (2010/12/11)
4.1.0.1 - Fixed vB4.0.1 not filtering posts at all (2010/12/11)
4.0.8.3 - Fixed HTML clobbering when filtering the word "ass", plus optimised Blog filtering (2010/11/09)
4.0.8.2 - Added minimum age required to turn off the profanity filter
4.0.8.1 - Fix to prevent over filtering if a trailing comma is put in the filtered words list (2010/11/03)
4.0.8.0 - Initial release (2010/11/02)

[mawby]

Originally Posted by inshooter

PM inbound, and boy is it awful - the mask is the default $#@!

I've traced this problem to having the word "ass" in the profanity filter list. The filter works by doing search and replaces on text before it is sent to the browser. In most cases this is done before vB has rendered it (.i.e the plain text is changed) but there are a couple of places where this is not possible and the replacement is done after it has been rendered (i.e. is has the HTML tags place). The last post column is one place where the replacement is done after rendering, and the inclusion of "ass" in the list was resulting in <p class="lastposttitle"> being turned into <p cl$#@!="lastposttitle">!

Whoops. I'll look into fixing that now.

[8thos]

This mod is %^#$%$# awesome!

[inshooter]

Just wanted to let everyone know that mawby stepped up and took my issue by the horns and squared it away on my forum. That is a stand-up developer.

I will be voting this Mod every way I can.

Thanks again mawby!

P.S. - I sent a little something your way.

[mawby]

Originally Posted by mawby

Whoops. I'll look into fixing that now.

I've uploaded a new version of both files which will fix this problem. As a result I also had to review the Blogs specific filters as these had the same problem, and I've made major improvements to those so I would recommend upgrading. One plugin I couldn't fix properly so instead it will simply ignore the word "ass"; it's a bit naff but I have raised a few enhancement requests on Vb.com for some new hooks which will allow me to fix this properly in the future.

Originally Posted by inshooter

Just wanted to let everyone know that mawby stepped up and took my issue by the horns and squared it away on my forum. That is a stand-up developer.

I will be voting this Mod every way I can.

Thanks again mawby!

P.S. - I sent a little something your way.

I'm glad it's fixed. I'm a bit of a perfectionist when it comes to my code so if it doesn't work I get most annoyed! Thanks for the donation, it's most appreciated. :up:

[sulasno]

Originally Posted by mawby

I like the age option, so I've added it.

You can now set the age in the settings...



And if the user is not old enough they will see this in their user cp...

does this mean that if I use 1000, nobody can turn it off ? :-)

[mawby]

It does, but you could also set Field Editable by User = No in the user profile field.

[misuse]

Not working in 4.1.0 Patch 2.

The main thread titles are censored but the post title and posts are not.

Thanks a ton mawby. I was going to get this developed. I'll just send you the $ instead.

[mawby]

Originally Posted by misuse

Not working in 4.1.0 Patch 2.

I've updated the products with a fix for this.

[mawby]

I've just spotted the post titles of search results when searching by posts had also stopped being filtered. I've updated the products again to fix this issue.

[sticky]

Will it work with older versions?