User-optional Replacements-based Censorship

User-optional Replacements-based Censorship Hack
================================================

Rationale:
----------

Some of my forum members wanted a swear filter for use at work, but others didn't. I searched for a hack that could do that and I saw a similar hack ( https://vborg.vbsupport.ru/showthread.php?t=53640 ) by 006 but that's for vB 2.2.* and I have vB 3.0.0. I started to look at the hack to install it but it looked significantly different from the code I had for vB, so I thought it'd be simpler to write a new version for vB 3 from scratch. This is it.

Description:
------------

The "bad words" censorship filter built in to vBulletin has at least three drawbacks:

1. It's all or nothing - all users are subject to the censorship whether they choose to be or not.

2. Censored words are replaced by asterisks and are not recoverable, even if the censorship is subsequently removed.

3. There is only a single list possible, where a forum administrator may wish different censorship lists within different styles (if they relate to different fora, for example).

This hack is a solution.

Based upon the built-in Replacement Variables system, this hack enables individual users to specify whether they want to view censored posts or not. Even if the Administrator chooses not to censor his forum, individual members sometimes prefer some words to be censored because they view in an office environment and Web proxies log certain words, or because minors may be present and read the screen.

Using his own "Edit Options" page, a member of your forum can turn his censorhip on or off unilaterally, and because of the way the replacements system works this is an entirely reversible operation. He can view censored posts at work, then log in at home and turn the censorship off again to view the posts as intended.

Also because of the way the replacements system works, censorship should take place in thread titles as well as posts.

If there are words that simply must be censored for all users, the built-in global censorship system can deal with that.

Caveats:
--------

Using the Replacement Variables system in this manner may preclude its use from any other function.

I have no useful information relating to how much additional load this will put in your server. I would imagine it would be minimal if the list of words is short or most users have censorship turned off.

Hack Information:
-----------------

Queries to run: 1
Files to modify: 2
Templates to modify: 1
Phrases to add: 4

Estimated time to install hack: 5 minutes

As ever, please take sensible precautions before installing this hack; back up your database and files beforehand. I have tested this hack on my own forum and my test forum and found it to be fine, but I am not responsible for the application of any hack I don't do myself.

For support, please use this thread or email me if you don't get a response. Thanks.

Daren "Rico" Chandisingh
rico[at]justice-department.org.uk
http://www.respawned.co.uk/forums/

[ptbyjason]

Oh thank you so much! I have been wanting to do this but I had no idea how. Now everyone will be happy. THANK YOU!

[tjdrico]

Originally Posted by Sonikku

I tried to install it but dunno why it af fected it, but my background image disappeared. 'Twas odd. I uninstalled it. Oh well, nice hack though.

I can't imagine why that would be, unless you were already using the replacement variables for something else, or added a word that modified your display template somehow. The replacement variables don't just get operated upon post contents, but entire templates, so it's quite possible that something like that happened. If you try re-installing the hack, check that it doesn't affect your forum display before adding any words. If it only happens with some words, then change those words, or change the part of the template that's being altered (such as the image name or URL). I can't think why else it would be happening.

[Cyricx]

Very awesome! Thank you TONS

[Gio Takahashi]

this is interesting however, I want to make it so that it is censored from Guests. Is it possible?

[tjdrico]

Originally Posted by Gio Takahashi

this is interesting however, I want to make it so that it is censored from Guests. Is it possible?

Yes, it's a simple change.

Open ./includes/functions.php and replace this:

PHP Code:

    // USER OPTIONAL REPLACEMENTS AS WORD CENSOR HACK
    // Use replacements as an optional display-time swear filter.
    if (0 == $bbuserinfo['usereplacementscensor'])
    {
        // this user doesn't want censoring
        // so just return the text as given
        return $newtext;
    } 


with this:

PHP Code:

    // USER OPTIONAL REPLACEMENTS AS WORD CENSOR HACK
    // Use replacements as an optional display-time swear filter.
    if ( (0 == $bbuserinfo['usereplacementscensor']) && (0 != $bbuserinfo['userid']) )
    {
        // this user doesn't want censoring
        // so just return the text as given
        return $newtext;
    } 


Save and close the file. That should be that, and guests will be subject to censorship. I'll update the main instructions with this information.

[Oblivion Knight]

The zip file has disappeared..
I was just going to install this, and now I can't.!

[tjdrico]

Originally Posted by Oblivion Knight

The zip file has disappeared..
I was just going to install this, and now I can't.!

Oddness! Hehe, I think I screwed up when I was updating the instructions. Should be back now - sorry about that. =)

[Oblivion Knight]

It doesn't appear to be working for me..

I'm using 3.0.1.. The Microstats hack also touches the same area of code in includes/functions.php, but I don't think that's the cause of it. The censor is disabled in the Admin CP, and tested on my account to enable the censor option - and the words are still visible uncensored..

Any ideas?

[007]

Good work tjdrico. I don't have VB3 yet (plan to upgrade in the next week or so) so it will be nice not to have to rehack this one. Thanks for giving me credit for the idea. Looks like you have managed to take yours a step further and get it to work with titles as well. Looks good. I will install for sure when I upgrade.

[tjdrico]

Thanks 006, but there was absolutely zero extra effort involved in getting it to work with titles as well as thread bodies. The way the replacements system works, the entire page seems to be fed through the filter before it's sent to the browser, so it's always likely to catch everything. I may be wrong there, but it seems that way.

It could present a problem if a forum used a, image URL or something that matches part of the replaced text - users with the censorship turned on would end up with missing images. =)